<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:25 CEST 2016 -->
    <title>SockJSHandler (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="SockJSHandler (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../../index.html?io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler" target="_top">Frames</a></li>
            <li><a href="SockJSHandler.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.ext.web.handler.sockjs</strong></div>

    <h2 title="[Groovy] Class SockJSHandler" class="title">[Groovy] Class SockJSHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>io.vertx.groovy.ext.web.handler.sockjs.SockJSHandler
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">

            <dl>
                <dt>All Implemented Interfaces and Traits:</dt>
                <dd>io.vertx.core.Handler</dd>
            </dl>
            <!-- todo: direct known subclasses -->
            <hr>
            <br>
<pre>@groovy.transform.CompileStatic
class SockJSHandler
extends java.lang.Object

</pre>



    <p>
 A handler that allows you to handle SockJS connections from clients.
 <p>
 We currently support version 0.3.3 of the SockJS protocol, which can be found in
 <a href="https://github.com/sockjs/sockjs-protocol/tree/v0.3.3">this tag:</a>
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#SockJSHandler(java.lang.Object)">SockJSHandler</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#bridge(Map<String, Object>)">bridge</a></strong>(java.util.Map&lt;java.lang.String, java.lang.Object&gt; bridgeOptions = [:])</code><br>Bridge the SockJS handler to the Vert.x event bus. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#bridge(Map<String, Object>, Handler<BridgeEvent>)">bridge</a></strong>(java.util.Map&lt;java.lang.String, java.lang.Object&gt; bridgeOptions = [:], io.vertx.core.Handler&lt;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/BridgeEvent.html' title='BridgeEvent'>BridgeEvent</a>&gt; bridgeEventHandler)</code><br>Like <a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html#bridge' title='SockJSHandler.bridge'>SockJSHandler.bridge</a> but specifying a handler
 that will receive bridge events.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.core.Vertx)">create</a></strong>(<a href='../../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</code><br>Create a SockJS handler</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.core.Vertx, Map<String, Object>)">create</a></strong>(<a href='../../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx, java.util.Map&lt;java.lang.String, java.lang.Object&gt; options)</code><br>Create a SockJS handler</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#handle(io.vertx.groovy.ext.web.RoutingContext)">handle</a></strong>(<a href='../../../../../../../io/vertx/groovy/ext/web/RoutingContext.html'>RoutingContext</a> arg0)</code><br></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#installTestApplications(io.vertx.groovy.ext.web.Router, io.vertx.groovy.core.Vertx)">installTestApplications</a></strong>(<a href='../../../../../../../io/vertx/groovy/ext/web/Router.html'>Router</a> router, <a href='../../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</code><br>Install SockJS test applications on a router - used when running the SockJS test suite</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#socketHandler(Handler<SockJSSocket>)">socketHandler</a></strong>(io.vertx.core.Handler&lt;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSSocket.html' title='SockJSSocket'>SockJSSocket</a>&gt; handler)</code><br>Set a SockJS socket handler. </td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="SockJSHandler(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>SockJSHandler</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="bridge(Map<String, Object>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a> <strong>bridge</strong>(java.util.Map&lt;java.lang.String, java.lang.Object&gt; bridgeOptions = [:])</h4>
                                <p> Bridge the SockJS handler to the Vert.x event bus. This basically installs a built-in SockJS socket handler
 which takes SockJS traffic and bridges it to the event bus, thus allowing you to extend the server-side
 Vert.x event bus to browsers
   <DL><DT><B>Returns:</B></DT><DD>a reference to this, so the API can be used fluently</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>bridgeOptions</code> -  options to configure the bridge with (see <a href="../../../../../../../../../cheatsheet/BridgeOptions.html">BridgeOptions</a>)</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="bridge(Map<String, Object>, Handler<BridgeEvent>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a> <strong>bridge</strong>(java.util.Map&lt;java.lang.String, java.lang.Object&gt; bridgeOptions = [:], io.vertx.core.Handler&lt;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/BridgeEvent.html' title='BridgeEvent'>BridgeEvent</a>&gt; bridgeEventHandler)</h4>
                                <p> Like <a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html#bridge' title='SockJSHandler.bridge'>SockJSHandler.bridge</a> but specifying a handler
 that will receive bridge events.
   <DL><DT><B>Returns:</B></DT><DD>a reference to this, so the API can be used fluently</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>bridgeOptions</code> -  options to configure the bridge with (see <a href="../../../../../../../../../cheatsheet/BridgeOptions.html">BridgeOptions</a>)</DD><DD><code>bridgeEventHandler</code> -  handler to receive bridge events</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="create(io.vertx.groovy.core.Vertx)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a> <strong>create</strong>(<a href='../../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</h4>
                                <p> Create a SockJS handler
   <DL><DT><B>Returns:</B></DT><DD>the handler</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>vertx</code> -  the Vert.x instance</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="create(io.vertx.groovy.core.Vertx, Map<String, Object>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a> <strong>create</strong>(<a href='../../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx, java.util.Map&lt;java.lang.String, java.lang.Object&gt; options)</h4>
                                <p> Create a SockJS handler
   <DL><DT><B>Returns:</B></DT><DD>the handler</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>vertx</code> -  the Vert.x instance</DD><DD><code>options</code> -  options to configure the handler (see <a href="../../../../../../../../../cheatsheet/SockJSHandlerOptions.html">SockJSHandlerOptions</a>)</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="handle(io.vertx.groovy.ext.web.RoutingContext)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>void <strong>handle</strong>(<a href='../../../../../../../io/vertx/groovy/ext/web/RoutingContext.html'>RoutingContext</a> arg0)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="installTestApplications(io.vertx.groovy.ext.web.Router, io.vertx.groovy.core.Vertx)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;void <strong>installTestApplications</strong>(<a href='../../../../../../../io/vertx/groovy/ext/web/Router.html'>Router</a> router, <a href='../../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</h4>
                                <p> Install SockJS test applications on a router - used when running the SockJS test suite
   <DL><DT><B>Parameters:</B></DT><DD><code>router</code> -  the router to install on</DD><DD><code>vertx</code> -  the Vert.x instance</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="socketHandler(Handler<SockJSSocket>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler.html'>SockJSHandler</a> <strong>socketHandler</strong>(io.vertx.core.Handler&lt;<a href='../../../../../../../io/vertx/groovy/ext/web/handler/sockjs/SockJSSocket.html' title='SockJSSocket'>SockJSSocket</a>&gt; handler)</h4>
                                <p> Set a SockJS socket handler. This handler will be called with a SockJS socket whenever a SockJS connection
 is made from a client
   <DL><DT><B>Returns:</B></DT><DD>a reference to this, so the API can be used fluently</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>handler</code> -  the handler</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../../index.html?io/vertx/groovy/ext/web/handler/sockjs/SockJSHandler" target="_top">Frames</a></li>
            <li><a href="SockJSHandler.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>